home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / kernel / rpc / rpcPacket.h < prev    next >
C/C++ Source or Header  |  1992-12-18  |  9KB  |  227 lines
  1. /*
  2.  * rpcPacket.h --
  3.  *
  4.  * This defines the RPC packet header format.  This header comes just
  5.  * after the packet transport header.  It contains information about the
  6.  * remote procedure call and is followed by parameters and data for the
  7.  * RPC.
  8.  *
  9.  * Copyright (C) 1987 Regents of the University of California
  10.  * All rights reserved.
  11.  * Permission to use, copy, modify, and distribute this
  12.  * software and its documentation for any purpose and without
  13.  * fee is hereby granted, provided that the above copyright
  14.  * notice appear in all copies.  The University of California
  15.  * makes no representations about the suitability of this
  16.  * software for any purpose.  It is provided "as is" without
  17.  * express or implied warranty.
  18.  *
  19.  * This packet format no longer agrees with the old-old sprite-unix
  20.  * hybrid (header "fsp.h")
  21.  *
  22.  * sccsid "Sprite $Header: /cdrom/src/kernel/Cvsroot/kernel/rpc/rpcPacket.h,v 9.11 92/12/13 18:21:35 mgbaker Exp $"
  23.  */
  24.  
  25. #ifndef _RPCPACKET
  26. #define _RPCPACKET
  27.  
  28. #ifdef KERNEL
  29. #include <rpcTypes.h>
  30. #else
  31. #include <kernel/rpcTypes.h>
  32. #endif /* KERNEL */
  33.  
  34. /*
  35.  * The Rpc header.
  36.  */
  37. typedef struct RpcHdr {
  38.     unsigned int    version;    /* This is a combined version number
  39.                      * and byte-order indicator.  See
  40.                      * the defines below. */
  41.     unsigned int    flags;        /* Protocol flags, explained below */
  42.     int            clientID;    /* Client Sprite host id */
  43.     int            serverID;    /* Server Sprite host id */
  44.     int            channel;    /* The client channel number */
  45.     int            serverHint;    /* Server index hint. The server
  46.                      * machine updates this on every
  47.                      * packet it sends to a client.  The
  48.                      * channel being used for the RPC
  49.                      * should preserve the value sent
  50.                      * and return it (in this field) with
  51.                      * future messages to the server */
  52.     unsigned int    bootID;        /* Client boot timestamp.  This changes
  53.                      * each time a host reboots. */
  54.     unsigned int    ID;        /* ID/sequence number. This ID is the
  55.                      * same on all packets pertaining
  56.                      * to the same RPC. This increases
  57.                      * until the origniating host reboots */
  58.     unsigned int    delay;        /* Interfragment delay info */
  59.     unsigned int    numFrags;    /* Number of fragments in packet (<=16).
  60.                      * If the packet is complete, ie. no
  61.                      * fragmenting, then this field should
  62.                      * be ZERO */
  63.     unsigned int    fragMask;    /* Fragment bitmask ID. The I'th frag
  64.                      * has the I'th bit of this mask
  65.                      * set.  If no fragments then this
  66.                      * field should be ZERO.  On partial
  67.                      * acknowledgments this contains
  68.                      * the receiver's summary bitmask */
  69.     int            command;    /* Rpc command (see rpcCall.h) or
  70.                      * error code if RPC_ERROR is set */
  71.     int            paramSize;    /* Size of the parameter area */
  72.     int            dataSize;    /* Size of the data data area */
  73.     int            paramOffset;    /* This is the starting offset for the
  74.                      * block of parameter bytes sent in
  75.                      * this fragment.  This is zero for
  76.                      * unfragmented sends and for the first
  77.                      * fragment of a group */
  78.     int            dataOffset;    /* Offset for the data area. */
  79. } RpcHdr;                /* 64 BYTES */
  80.  
  81.  
  82. /*
  83.  * Version number / byte-ordering word.
  84.  *    RPC_NATIVE_VERSION    Version number in native format
  85.  *    RPC_SWAPPED_VERSION    Version number if originating on a Vax byte
  86.  *                ordered host and read on a MC680xx host,
  87.  *                or vice versa.
  88.  *    To change the version number increment the right-most byte
  89.  *    in the native version.
  90.  */
  91.  
  92. /*
  93.  *    Version 1:    6-13-88        Original.
  94.  *    Version 2:    6-19-88        For cleaning up parameters in
  95.  *                    preparation for byte-swapping.
  96.  *    Version 3:    6-8-89        New FS parameters.  New ethernet
  97.  *                    packet type (not 0x500 !!)
  98.  */
  99. #define    RPC_NATIVE_VERSION    0x0f0e0003
  100. #define RPC_SWAPPED_VERSION    0x03000e0f
  101.  
  102. /*
  103.  * These are the version variables actually used in the kernel. You can
  104.  * change them early in the boot if you want a different version number.
  105.  */
  106.  
  107. extern int     rpc_NativeVersion;
  108. extern int    rpc_SwappedVersion;
  109.  
  110. /*
  111.  * The flags field is used to type packets and for flags that
  112.  * modify the packet type.
  113.  *
  114.  * Packet Types:
  115.  *    RPC_REQUEST a request message sent by the client to the server.
  116.  *
  117.  *    RPC_REPLY a reply message returned to the client from the server.
  118.  *
  119.  *    RPC_ACK an explicit acknowledgment message for a request or reply.
  120.  *    If the RPC_LASTFRAG flag is present then this is a partial
  121.  *    acknowledgment and the summary bitmask is in the fragMask field.
  122.  *
  123.  *    RPC_ECHO a special packet that just is bounced off the server by
  124.  *    the dispatcher.  A server process is not involved.
  125.  *
  126.  *    RPC_NACK a negative acknowledgement from the server saying that it's
  127.  *    alive, but can't handle the request yet (no server process for it, etc).
  128.  *
  129.  * Packet Flags:
  130.  *    RPC_PLSACK demands an explicit acknowledgment message from the receiver.
  131.  *
  132.  *    RPC_LASTFRAG is present on the last fragment of a batch being sent,
  133.  *    which is not always the last fragment in a message because a partial
  134.  *    partial re-send may only involve some fragments in the middle
  135.  *    of the message.  This flag set on partial acknowledgments.
  136.  *
  137.  *    RPC_CLOSE only valid on type RPC_ACK messages.  This means the server
  138.  *    is requesting acknowledgement of its last reply so it can reassign
  139.  *    the server process to an active client channel.  When combined with
  140.  *    RPC_SERVER, this means the client has successfully gotten its
  141.  *    last reply.
  142.  *
  143.  *    RPC_ERROR indicates the service routine had an error, in this
  144.  *    case the command field contains an error code.
  145.  *
  146.  *    RPC_NOT_ACTIVE means that the originating host is not fully alive.
  147.  *    This means the packet is ignored by the recovery module, but still good.
  148.  *
  149.  *    RPC_FAST means this rpc packet comes from a server than was rebooted
  150.  *    with a "fast boot" and therefor no recovery is necessary if we
  151.  *    thought it was dead.
  152.  *
  153.  *    RPC_SERVER_RECOV means that the server is driving crash recovery
  154.  *    and the clients must wait until it contacts them in order to reopen
  155.  *    their files.
  156.  *
  157.  * Flags only valid in trace records:
  158.  *    RPC_SERVER the packet is bound for the server side of the rpc system.
  159.  *
  160.  *    RPC_LAST_REC the trace record is the oldest trace record in the
  161.  *    circular buffer.
  162.  *
  163.  *    RPC_FLAGS is gross, because it has two non-contiguous flag areas.
  164.  *    This is because the RPC_TYPE fields are smack in the middle of
  165.  *    the flags integer, and we ran out of space for regular flags.
  166.  */
  167. #define RPC_NO_FLAGS        0x0
  168. #define RPC_FLAGS        0xff00ff
  169. #define RPC_PLSACK        0x000001
  170. #define RPC_LASTFRAG        0x000002
  171. #define RPC_CLOSE        0x000004
  172. #define RPC_ERROR        0x000008
  173. #define RPC_SERVER        0x000010
  174. #define RPC_LAST_REC        0x000020
  175. #define RPC_NOT_ACTIVE        0x000040
  176. #define    RPC_FAST        0x000080
  177. /* Skip over bits used in RPC_TYPE, below. */
  178. #define    RPC_SERVER_RECOV    0x010000
  179.  
  180. #define RPC_TYPE        0x00ff00
  181. #define RPC_REQUEST        0x000100
  182. #define RPC_ACK            0x000200
  183. #define RPC_REPLY        0x000400
  184. #define RPC_ECHO        0x000800
  185. #define    RPC_NACK        0x001000
  186.  
  187. /*
  188.  * Items related to Fragmenting.
  189.  *
  190.  * The maximum size supported by fragmentation is 16K of data plus
  191.  * 1k of parameters.  This large chunk is broken into fragments.
  192.  * The maximum size of a datagram is dependent on the transport medium.
  193.  */
  194. #define RPC_MAX_NUM_FRAGS    16
  195. #define RPC_MAX_FRAG_SIZE    1024
  196. #define RPC_MAX_DATASIZE    (RPC_MAX_NUM_FRAGS * RPC_MAX_FRAG_SIZE)
  197. #define RPC_MAX_PARAMSIZE    (1 * RPC_MAX_FRAG_SIZE)
  198. #define RPC_MAX_SIZE        (RPC_MAX_DATASIZE+RPC_MAX_PARAMSIZE)
  199.  
  200. /*
  201.  * An array of bitmasks is kept so the dispatcher can quickly determine if
  202.  * a message is complete.  Indexed by the total number of fragments in the
  203.  * packet, the array contains a complete bitmask for that many fragments.
  204.  */
  205. extern unsigned int rpcCompleteMask[];
  206.  
  207. /*
  208.  * Machines have some minimum delay that they can handle between successive
  209.  * packets before they start to drop them.  The current notion of this delay
  210.  * for other hosts is kept in rpcDelay.  This machine's currently acceptable
  211.  * delay is kept in rpcMyDelay, while its max speed at generating packets is
  212.  * kept in rpcOutputRate.  This information is used to insert, if neccesary,
  213.  * delays between transmission of fragments.
  214.  */
  215. extern short rpcDelay[];        /* Other host's inter-frag delay */
  216. extern unsigned short rpcMyDelay;    /* This host's inter-frag delay */
  217. extern unsigned short rpcOutputRate;        /* This machines output rate */
  218.  
  219. /*
  220.  * Forward Declarations.
  221.  */
  222. extern ReturnStatus RpcOutput _ARGS_((int spriteID, register RpcHdr *rpcHdrPtr, RpcBufferSet *message, RpcBufferSet *fragment, unsigned int dontSendMask, Sync_Semaphore *mutexPtr));
  223.  
  224. extern void RpcGetMachineDelay _ARGS_((unsigned short *myDelayPtr, unsigned short *outputRatePtr));
  225.  
  226. #endif /* not _RPCPACKET */
  227.